home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 1 Issue 2 / PDCD-1 - Issue 02.iso / _utilities / utilities / 004 / _clicback / !ClicBack / !Help < prev    next >
Text File  |  1994-11-16  |  26KB  |  571 lines
  1.         Please note that this application is
  2.  
  3.  
  4.           CCCCC   AAAA   RRRRR   EEEEEE  WW   WW  AAAA   RRRRR   EEEEEE
  5.         CC       AA  AA  RR  RR  EE      WW   WW AA  AA  RR  RR  EE
  6.         CC       AA  AA  RR  RR  EE      WW W WW AA  AA  RR  RR  EE
  7.         CC       AAAAAA  RRRRR   EEEEE   WW W WW AAAAAA  RRRRR   EEEEE
  8.         CC       AA  AA  RR RR   EE      WWWWWWW AA  AA  RR RR   EE
  9.         CC       AA  AA  RR  RR  EE      WWW WWW AA  AA  RR  RR  EE
  10.           CCCCC  AA  AA  RR  RR  EEEEEE  WW   WW AA  AA  RR  RR  EEEEEE
  11.  
  12.         It is NOT free software.
  13.         
  14.         You may pass on copies of this Demonstration Copy to your friends 
  15.         providing that it is distributed complete with this documentation 
  16.         file, and with the copyright message intact.
  17.         
  18.  
  19.                                            !ClicBack
  20.                                   Hard Disk Backup Utilities
  21.                                          Version 2.06
  22.                                       ⌐ Steve Spry 1993.
  23.                                       
  24.                                       
  25.         !ClicBack Utilities are CAREWARE and NOT PUBLIC DOMAIN.  This means
  26.         that the proceeds are given to charity.  In the case of these
  27.         programs the charity is CLIC,  The Cancer & Leukaemia In Childhood
  28.         Trust, registered charity number 802396.
  29.  
  30.         If, after a period of two weeks, you find the program useful you are
  31.         required to register  your copy of the programs for a fee of ú10.
  32.         This payment will entitle you to free upgrades of the programs and a
  33.         fully working copy of the !Whoops program.
  34.         
  35.         Please send a cheque, postal orders, suggested improvements or bug 
  36.         reports to:
  37.  
  38.                     Steve Spry
  39.                     36 Moreton Avenue
  40.                     Bideford
  41.                     North Devon
  42.                     EX39 3AY
  43.  
  44.         If you could also inform me as to which version of RISCOS you have, 
  45.         the amount of memory you have and the size of your hard disk it 
  46.         would help me to develop the program further.
  47.         
  48.         The Demonstration version of these utilities have the following 
  49.         restrictions.
  50.         
  51.         1.  The !Restore program will only restore the first 33 Megs of the
  52.             backup data.  This should be enough for you to assess the program
  53.             
  54.         2.  The !Whoops program does not restore anything, but has been
  55.             included for completeness.
  56.             
  57.         Obviously these restrictions will not be imposed on the full copies.
  58.         
  59.     RISCOS 3 Users
  60.     ~~~~~~~~~~~~~~
  61.     The program reads the CMOS setting for 3D windows and either uses the
  62.     standard RISCOS 2, 2D windows, or the 3D windows.
  63.         
  64.         Background
  65.         ~~~~~~~~~~
  66.         This program had been sitting on my hard disk for nearly three years 
  67.         in a half finished state whilst I played around with data 
  68.         compression techniques. 
  69.         Following the death of my five year old son from a brain tumour 
  70.         in January 1993 I decided to finish this program and donate the 
  71.         proceeds to CLIC.  As the program progressed more and more features 
  72.         were added or changed. Even now there are things that I would like
  73.         to change but I could carry on for ever.
  74.         
  75.         
  76.         This program is dedicated to his memory and all those brave young
  77.         children fighting all forms of cancer.  For there sake, if you like
  78.         the program,please register your copy of the program.
  79.         
  80.         Further details about CLIC can be obtained from:
  81.            
  82.                             CLIC Annexe,
  83.                             3 Nugent Hill
  84.                             Bristol
  85.                             BS6 5TD
  86.         
  87.                                          Introduction
  88.                                          ~~~~~~~~~~~~                        
  89.         The main features of the programs include :
  90.             Full, Differential and Incremental backups.
  91.             Selective option to preserve history integrity
  92.             Backup to floppies or another hard disk.
  93.             Backup only specified directories or files.
  94.             Exclude any files or directories from the backup.
  95.             Verify whilst backing up.
  96.             Password protection for added security.
  97.             32 bit CRC
  98.             Restore data to any directory.
  99.             Powerful searching facility to locate Files / Directories or
  100.               Applications within backup data.
  101.             Ability to restore whole directories or applications.
  102.             Variable data compression.
  103.             Estimate number of floppy disks required.
  104.             Estimate time required to complete backup.
  105.             Time taken so far.
  106.             Save settings as configuration files.
  107.             Customisation file.
  108.         Acorn's Interactive help supported.
  109.         
  110.                                         Getting Started
  111.                                         ~~~~~~~~~~~~~~~
  112.         To load the program double click on the !ClicBack icon.  The program
  113.         will be loaded and  the !ClicBack icon will be displayed on the right
  114.         hand side of the iconbar.
  115.  
  116.         Iconbar Menu
  117.         ~~~~~~~~~~~~
  118.         Clicking menu over the !ClicBack icon will display the following 
  119.         menu.
  120.  
  121.         Info
  122.         ~~~~ 
  123.         Info will display information about your version of the program.
  124.         The Serial No will be  unique to your copy and should be quoted in 
  125.         any correspondence.
  126.  
  127.         Save
  128.         ~~~~
  129.         Save leads to a standard "SaveAs" dialogue box which enables you to
  130.         save the current  settings to a configuration file.  The !ClicBack
  131.         program can be started by double clicking  on a configuration file.
  132.         The program will be loaded with the options from the  configuration
  133.         file.
  134.  
  135.         Quit
  136.         ~~~~
  137.         Quit will exit !ClicBack, removing it from the computers memory.
  138.  
  139.         Clicking SELECT on the !ClicBack icon on the iconbar will display the
  140.         Setup Window  shown below.
  141.  
  142.         This window displays the various settings available.
  143.  
  144.                                        Main Window Menu
  145.                                        ~~~~~~~~~~~~~~~~
  146.         Clicking menu over the main window will display the following menu.
  147.  
  148.  
  149.         Info
  150.         ~~~~
  151.         Info will display information about your version of the program.  The
  152.         Serial Number will be unique to your copy and should be quoted in any
  153.         correspondence. In the evaluation copy this will display 
  154.         "Demonstration"
  155.  
  156.         Destination
  157.         ~~~~~~~~~~~
  158.         The number of floppy drives connected to your computer is detected by
  159.         the program  and the menu modified automatically to account for this.
  160.  
  161.         Clicking on "Other" will display an error prompting you to drag the
  162.         destination directory  to the destination icon in the main window.
  163.  
  164.         Clicking on any of the Drive entries will insert the destination into
  165.         the Destination icon.
  166.  
  167.         Misc
  168.         ~~~~
  169.         This menu entry leads to the following sub-menu
  170.  
  171.         Include
  172.         ~~~~~~~
  173.         Clicking on this menu entry will display the Include File window.
  174.         Dragging files or directories to this window will include them into
  175.         the backup.  It is not  necessary to include files or directories 
  176.         that are within the source directory as these will  be backed up
  177.         automatically. The Include list will only be used if the "Use Include
  178.         List" option is selected.
  179.  
  180.         Exclude
  181.         ~~~~~~~
  182.         Clicking on this menu entry will display the Exclude File window.
  183.         Dragging files or directories to this window will add them to the
  184.         Exclude List.  It is not  necessary to exclude files or directories
  185.         that are not within the source directory as  these will be excluded
  186.         automatically.
  187.  
  188.         The Exclude list will only be used if the "Use Exclude List" option 
  189.         is selected.
  190.  
  191.         History
  192.         ~~~~~~~
  193.         Clicking on this menu entry will display the History Window as shown
  194.         below.
  195.  
  196.         This window gives date and time that the backups were completed,
  197.         whether the  backups were Selective or Non-Selective, backup type and
  198.         the time taken to backup. From time to time you may wish to delete
  199.         some of the entries from the History file. Pressing menu over this
  200.         window will display the following menu.
  201.  
  202.         Only the bottom entry needs any explanation.  The Remove option will
  203.         delete the  selected History file entries.  Individual entries may be
  204.         selected by clicking SELECT on  the required entry.  Multiple entries
  205.         can be made by using ADJUST.
  206.  
  207.         Password
  208.         ~~~~~~~~
  209.         This menu option leads to a writable icon into which you may 
  210.         specify a password to  use when backing up the data.  The password
  211.         must be at least two characters long and  not more than eight 
  212.         characters. The password is not stored with the backup data.  
  213.         It is therefore important that you  remember the password.  
  214.         The Password is also CASE SENSITIVE i.e. KEY is not the same 
  215.         password as Key. If the backup has been password protected the 
  216.         !Restore program will prompt you for a password before the 
  217.         restoration of data starts, but has no means of checking that the  
  218.         password is correct.
  219.         
  220.         Compression
  221.         ~~~~~~~~~~~
  222.         This allows the user to set the amount of compression the program
  223.         will attempt. The permitted values are in the range 1 to 9 with 9
  224.         being the maximum compression.  The default value is 1 which provides
  225.         the best compromise for speed whilst maintaining an adequate amount
  226.         of compression.  Setting this value to 9 will increase compression
  227.         but will increase the time taken for the backup.  The program uses
  228.         the same amount of memory regardless of the compression level.
  229.         
  230.                                     !ClicBack Setup Window
  231.                                     ~~~~~~~~~~~~~~~~~~~~~~
  232.  
  233.         Backup Type
  234.         ~~~~~~~~~~~
  235.         The Backup Type icons allows you to choose the type of backup you 
  236.         wish to perform.   There are three backup types available.
  237.  
  238.         Full Backup
  239.         ~~~~~~~~~~~
  240.         This type of backup backs up all the files on the source path to the
  241.         destination path.   This is first type of backup that you should
  242.         perform.   If there are no entries in the  History file, or the
  243.         History file is missing only Full Backup will be available.
  244.  
  245.         Incremental Backup
  246.         ~~~~~~~~~~~~~~~~~~
  247.         This type of backup backs up only those files which have been created
  248.         or modified  since the last backup.  The last backup maybe Full,
  249.         Incremental or Differential.
  250.  
  251.         Differential Backup
  252.         ~~~~~~~~~~~~~~~~~~~
  253.         A differential backup backs up only those files that have been 
  254.         created or modified since  the last Full backup.
  255.  
  256.         Selective
  257.         ~~~~~~~~~
  258.         For this option it is necessary to explain basically how the program
  259.         works.
  260.  
  261.         Because the Archimedes does not have a file attribute to indicate if
  262.         the file has been  modified or created since the last backup the
  263.         program has to rely on the entries in the  History file.  These
  264.         entries will inform the program what type of backup and when the
  265.         various backups were performed.  From this information the program 
  266.         can workout if a  file has been backed up.  Therefore if you perform
  267.         a backup of a directory other than  the root directory an entry 
  268.         will be written to the History file.  If at the same time you  have 
  269.         edited files in another directory these files would be missed from 
  270.         the next Incremental or Differential backup.  If the Selective option     is used the entry that will be  written to the History file will not
  271.         be used. This will ensure that the edited files will be  backed up 
  272.         in the next Incremental or Differential backup.
  273.  
  274.         File Source
  275.         ~~~~~~~~~~~
  276.         The File Source specifies the directory that you wish to backup.
  277.         Dragging a directory or  file to this icon will insert the full
  278.         pathname of that directory into the icon.  If the object  dragged is
  279.         a file the inserted path will be the parent directory.
  280.  
  281.         Alternatively you can type the path into this icon.
  282.  
  283.         Destination
  284.         ~~~~~~~~~~~
  285.         The Destination specifies where the backup data will be written to.
  286.         The destination  path can be set in one of two ways.   If the
  287.         destination is to floppy disks the destination  drive is selected via
  288.         the menu option "Destination".  If the destination is another hard
  289.         disk then simply drag the destination directory to the destination
  290.         icon.  Once again if the  dragged object is a file then the inserted
  291.         path will be the parent directory of the file. The two possible
  292.         destinations are :
  293.  
  294.                     ADFS floppy disk
  295.                     Other
  296.  
  297.         If the destination is to a floppy disk the program will prompt you 
  298.         for disks as required.   The program will also automatically delete 
  299.         all files on the floppy disk and name the  disk.
  300.  
  301.         If the destination is "Other" the program will not delete any files 
  302.         or attempt to name the  disk.
  303.  
  304.         Options
  305.         ~~~~~~~
  306.         The options enable you to select the options affecting the backup
  307.         process.
  308.  
  309.         Unstamped
  310.         ~~~~~~~~~
  311.         Incremental and Differential backups rely on the Date Time stamps of
  312.         files to  determine whether they should be backed up.  It is possible
  313.         for some files not to have a  Date Time stamp.  If unstamped is
  314.         selected then all unstamped files will be backed up,  otherwise they
  315.         will be ignored.  The default setting is deselected.  For a Full
  316.         backup this  option is not available and all Unstamped files will be
  317.         backed up.
  318.  
  319.         Verify
  320.         ~~~~~~
  321.         When Verify is selected the data that has just been written to the
  322.         destination file will be  verified to ensure that the data was 
  323.         written correctly.  If any errors are detected the  data will be 
  324.         written again.  This will slow down the backup considerably.
  325.  
  326.         Use Include List
  327.         ~~~~~~~~~~~~~~~~
  328.         The Use Include List option allows you to specify a list of files or
  329.         directories to backup.   Click on the Include option in the Misc menu
  330.         to display the Include window.  You may drag files / directories into
  331.         this window to create a list of files to be backed up.
  332.  
  333.         If this option is not selected then the contents of the Include list
  334.         are not used.
  335.  
  336.         Use Exclude List
  337.         ~~~~~~~~~~~~~~~~
  338.         The Use Exclude List option allows you to specify a list of files or
  339.         directories to exclude  from the backup.  Click on the Exclude option
  340.         in the Misc menu to display the Exclude  window.  You may drag 
  341.         files/directories into this window to create a list of files to be 
  342.         excluded.
  343.  
  344.         If this option is not selected then the contents of the Exclude list
  345.         are not used.
  346.  
  347.         When the program is started it will check for the presence of the
  348.         files in the lists.  If the  files are not found then the
  349.         file/Directory will be removed from the list for this backup.
  350.  
  351.         Cancel
  352.         ~~~~~~
  353.         Clicking on the Cancel icon will discard any changes you have made to
  354.         the settings and  reload the default settings.
  355.  
  356.         Save
  357.         ~~~~
  358.         Clicking on the Save icon will save the current settings as the
  359.         default settings.
  360.  
  361.         OK
  362.         ~~
  363.         Clicking on the OK icon will start the backup sequence.
  364.  
  365.                                         Backup Sequence
  366.                                         ~~~~~~~~~~~~~~~
  367.  
  368.         Before starting the backup you should quit any other applications 
  369.         that are currently  running.   The extra memory gained will speed up
  370.         the backup.   Once you have ensured  that the File source, 
  371.         Destination, backup type and other options are set correctly, you  
  372.         may start the backup by clicking on the OK icon.
  373.  
  374.         The first thing that happens during the backup sequence is a
  375.         pre-backup pass of the File  source.   This builds a log file of all
  376.         the files to be backed up, and the amount of data.   When the log 
  377.         file is complete the backup will start.   If you are not backing up 
  378.         to floppy  disks, the backup will commence immediately.   You can 
  379.         abandon the backup at any  time by clicking on Abort.  There maybe 
  380.         a short delay before the program  acknowledges your request to 
  381.         abandon the backup especially if the program is  compressing a large
  382.         file.
  383.  
  384.         Backup to Floppy Disk
  385.         ~~~~~~~~~~~~~~~~~~~~~
  386.         If you are backing up to floppy disks you will be prompted to insert
  387.         the first floppy disk  of the disk set.
  388.  
  389.         After inserting the disk into the drive click on OK. The program will
  390.         AUTOMATICALLY  DELETE any files on the destination floppy.
  391.  
  392.         An estimate of the number of disks required and the estimation of 
  393.         time left will be  updated as each floppy disk is filled.   The 
  394.         floppy disks will also be named to reflect the backup type, date and
  395.         disk number i.e.
  396.  
  397.                                     F21_Dec_02
  398.  
  399.         This indicates that the backup type was Full, the backup date was the
  400.         21st December  and this is disk number 02. As the backup progresses
  401.         you will be prompted to insert floppy disks as they are  required.
  402.         You can abandon the backup at any time by clicking on Abort.
  403.  
  404.         Backup progress
  405.         ~~~~~~~~~~~~~~~
  406.         During the backup, information is displayed in the ClicBack Status
  407.         window.
  408.  
  409.      Name             
  410.            Displays the pathname of the file currently being processed.
  411.  
  412.      Size  
  413.            Displays the original size of the file.
  414.  
  415.      Done  
  416.            Shows the percentage of the backup completed.
  417.  
  418.      Disk 
  419.            This displays the current disk number.
  420.  
  421.      of ~  
  422.            Displays an estimate of the number of disks required.
  423.            Updated  during the backup.
  424.  
  425.      Estimated Time left 
  426.            Displays an estimate of the time remaining for the backup to
  427.            including delays in inserting floppy disks.
  428.  
  429.      Compression
  430.            Displays the percentage of disk space saved.  This value might 
  431.            be negative when the program is unable to compress the input 
  432.            files.  This negative value arises because !ClicBack writes some 
  433.            internal information with the backup data.
  434.  
  435.         The backup can be aborted at any time by clicking on the Abort icon.
  436.         There may be  some delay whilst the current data chunk is compressed.
  437.         
  438.         The pause icon will pause the backup and free as much memory as possible 
  439.         from the memory buffer and text in the icon will change to 'Continue'.
  440.         When you select Continue the program will re-claim the memory and continue
  441.         with the backup.
  442.  
  443.         You might notice that the amount of data backed up is not the same as
  444.         the amount of used space on your hard disk.  This is due to the 
  445.         filing systems allocating space for directory entries.  Each 
  446.         directory will take one block of your hard disk.  Therefore if the 
  447.         block size is 1024 bytes each directory will take up 1k of disk 
  448.         space.  The backup program only needs the date/time stamp of the 
  449.         directory to recreate it on restoring the data.
  450.     --------------------------------------------------------------------
  451.     
  452.                                             Restore
  453.                                             ~~~~~~~
  454.         Double clicking on the !Restore icon will load the application onto 
  455.         the iconbar. Clicking on the icon will open the programs main window.
  456.  
  457.         The File Source and Destination icons will contain the default paths
  458.         for the restore.  These are obtained from a header within the 
  459.         BackData file.  The destination will be the same as the source for 
  460.         the original backup.
  461.  
  462.         If you wish to restore the data to a different directory or drive 
  463.         then either drag the destination directory (or a file from that 
  464.         directory) into the destination icon or press menu over the window 
  465.         and drag the save icon from the destination submenu to your 
  466.         selected directory.
  467.     
  468.     The menu has the following options.  
  469.     
  470.         Info
  471.         ~~~~ 
  472.         Info will display information about your version of the program.
  473.         The Serial No will be  unique to your copy and should be quoted in 
  474.         any correspondence.
  475.         
  476.         Source
  477.         ~~~~~~
  478.         The program expects to find the backup data file in the same
  479.         directory as the !Restore program. If the program can not find the
  480.         backup data an error will be displayed.
  481.         
  482.         When the program starts it will read certain details about the
  483.         backup from the backup data such as source and destination.
  484.         
  485.         Destination
  486.         ~~~~~~~~~~~
  487.         This will bring up a standard save as box. Dragging the file icon to
  488.         the destination directory will insert the full path into the
  489.         destination icon.  You can also select the destination directory by
  490.         dropping the selected directory onto the destination icon. This will
  491.         also insert the full path into the destination icon.  If you drop a
  492.         file onto the destination icon the parent directory will be inserted 
  493.         into the icon.
  494.  
  495.         Password
  496.         ~~~~~~~~
  497.         This menu option leads to a writable icon into which you will have to
  498.         enter the password if the backup is password protected. The Password
  499.         is also CASE SENSITIVE i.e. KEY is not the same password as Key. 
  500.         If the backup has been password protected but you do not enter a
  501.         password before starting the restore the program will prompt you for
  502.         a password before the restoration of data starts, but has no means 
  503.         of checking that the password is correct.
  504.         
  505.         Clicking on OK will start the restore process.
  506.  
  507.         -------------------------------------------------------------------
  508.  
  509.                                            Whoops
  510.                        ~~~~~~
  511.     This program is used to restore single files, directories or applications.
  512.     The program is loaded by double clicking on the !Whoops icon.
  513.     Clicking on the iconbar will open the programs main window.
  514.     
  515.     The main window has a writable icon for you to specify the name of the
  516.     file/directory or application which you wish to restore.
  517.     There is a group of three icons which enables you to select what type
  518.     of object you are looking for. The 'Wildcard' icon will extend the
  519.     window to show the available wildcards.
  520.     
  521.     The wildcards are as follows:
  522.     # Digit - Matches any characters 0-9
  523.     . Any   - Matches any single character
  524.     ~ Not   - Matches any character except the character specified.
  525.     
  526.     
  527.     The demonstration version of this program WILL NOT RESTORE ANY FILES.
  528.     It is only included as a demo of what the full program is capable of.
  529.     
  530.         Registered users will recieve a fully working copy of this program
  531.         which will (hopefully) be greatly enhanced in the future.
  532.         
  533.         --------------------------------------------------------------------
  534.         History
  535.         ~~~~~~~
  536.         1.00  Not so much of a hard disk backup program but a hard disk
  537.               cleaner. Managed to wipe every other file on a hard disk.
  538.               If it wasn't for a bug I would have had the lot. sorry Buck!
  539.               
  540.         2.00  
  541.         Future Plans
  542.         ~~~~~~~~~~~~
  543.         I intend to make the restore program more visually based. i.e. show
  544.         a directory tree and allow you to point and click to specify the
  545.         files to restore.
  546.         
  547.         Improve the search facilities to incorporate fuzzy matching. i.e. a
  548.         search for dirrectry would find directory.
  549.         
  550.         And the normal improvment ..... speed. I hope to double the program
  551.         speed of the backup eventually. The speed of restoration is already
  552.         pretty impressive for large files.
  553.         
  554.         known bugs
  555.         ~~~~~~~~~~
  556.         The program does not recognise PC hard disk partitions of type &FC8.
  557.         If you wish to backup a PC partition you will need to set the type
  558.         to 'Data'.
  559.         After completion of a backup selecting 'History' will sometimes
  560.         cause the program to crash. I haven't been able to locate this
  561.         problem at present.
  562.         
  563.         Thanks To
  564.         ~~~~~~~~~
  565.         Dominic Symes for THE text(?) editor !ZAP. If you haven't got a 
  566.         copy get one!
  567.         Martin Ebourne and Bryan Scattergood for the C/Assembler modes in 
  568.         !ZAP.
  569.         Acorn for there C Compiler (and computer).
  570.         Jonathan Marten for the insperation to start this program. (UAP ?)
  571.         Chris Taylor for the suggestions on improving the program and encouragement